Get navigation resource metadata
get
/resources/v1/metadata-catalog/aggregates/{siteName}/navigation
The resource endpoint returns description of the resource, including the resource name, a link to the json schema of the resource, and a link to the navigation resource instance when requested with "application/json". When requested with "application/schema+json", the json schema of the resource is returned. The default is "application/json".
Note: This is the metadata URL returned from an OPTIONS request of the navigation resource instance.
The following tables summarize the client request.
Path Parameters
Name | Description | Format |
---|---|---|
siteName | Name of the site | string |
The following tables summarize the server response.
Supported Media Types
- application/json
- application/schema+json
200 Response
Resource metadata.
Example 1
The following example shows how to get a description for a navigation resource by submitting a GET request on the REST resource using cURL.
curl -i -H "Accept: application/json" -X GET "http://<host>:<port>/<context>/REST/resources/v1/metadata-catalog/aggregates/avisports/navigation"
Example 1 Response Header
The following example shows the response header.
HTTP/1.1 200 OK ETag: "0495efa4e9b8daeafa1438226583354b666143535445cf4b85d48f98e0e5f6bb" Cache-Control: max-age=0 Content-Type: application/json;charset=utf-8
Example 1 Response Body
The following example shows the contents of the response body, in JSON format.
{ "name": "Aggregated Navigation Resource for entire site", "links": [ { "href": "http://<host>:<port>/<context>/REST/resources/v1/metadata-catalog/aggregates/avisports/navigation", "rel": "alternate", "templated": false, "mediaType": "application/schema+json", "method": "GET", "profile": "" }, { "href": "http://<host>:<port>/<context>/REST/resources/v1/metadata-catalog/aggregates/avisports/navigation", "rel": "canonical", "templated": false, "mediaType": "application/json", "method": "GET", "profile": "" }, { "href": "http://<host>:<port>/<context>/REST/resources/v1/aggregates/avisports/navigation", "rel": "describes", "templated": false, "mediaType": "application/json", "method": "GET", "profile": "" } ] }
Example 2
The following example shows how to get a json schema for a navigation resource, by submitting a GET request on the REST resource using cURL.
curl -i -H "Accept: application/schema+json" -X GET "http://<host>:<port>/<context>/REST/resources/v1/metadata-catalog/aggregates/avisports/navigation"
Example 2 Response Header
The following example shows the response header.
HTTP/1.1 200 OK Cache-Control: max-age=0,no-cache,no-store Content-Type: application/schema+json;charset=utf-8
Example 2 Response Body
The following example shows the contents of the response body, in JSON format.
{ "$schema": "http://<host>:<port>/<context>/schema/singularResource#", "title": "Aggregated Navigation Asset Schema", "allOf": [ { "$ref": "http://<host>:<port>/<context>/schema/singularResource#" }, { "$ref": "#/definitions/aggregatedNavigationAsset" } ], "definitions": { "aggregatedNavigationAsset": { "additionalProperties": true, "properties": { "start": { "$ref": "http://<host>:<port>/<context>/schema/subSchemas#/definitions/assetId" } }, "patternProperties": { ".+?:[0-9]+": { "$ref": "http://<host>:<port>/<context>/schema/subSchemas#/definitions/navigationAssetProperties" } }, "required": [ "start" ] } } }